package runnerworm.core;

/**
 * <p>Title: HighScoresAvailableEvent</p>
 * <p>Description: The event that will provide information about the high scores.</p>
 * @author Guilherme Mauro Germoglio Barbosa
 */

public class HighScoresAvailableEvent
    extends AvailableEvent {

  /**
   * The high scores.
   */
  private HighScores highScores;

  /**
   * Will need the event's source and the game's high scores.
   * @param source The event's source.
   * @param highScores The game's high scores.
   */
  public HighScoresAvailableEvent(AvailableEventLauncher source, HighScores highScores) {
    super(source, HIGH_SCORES_AVAILABLE);
    this.highScores = highScores;
  }

  /**
   * Returns a string containing the high Scores.
   * @return A String representation of the game's high scores.
   */
  public String getHighScores() {
    return highScores.toString();
  }

}